#!/bin/bash
#
# Lists all commands known to Pulley, along with command summaries.
#
# Author:   Dr. Mike Murphy (mmurphy2@coastal.edu)
# Revision: 18 November 2013
#
#   Copyright 2013 Coastal Carolina University
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#


## p_cmd_list_commands_help
##
## Echoes help information for the list_commands command. Returns 0.
##
function p_cmd_list_commands_help() {
	cat << EOF
Usage: pulley list_commands

Lists all commands known to Pulley, along with command summaries. For help
with a command, run pulley <command> --help

If this command is run with the --short argument, Pulley will print a list
of available commands without summary information.
EOF
	return 0
}


## p_cmd_list_commands_summary
##
## Echoes summary information for the list_commands command. Returns 0.
##
function p_cmd_list_commands_summary() {
	echo "Lists available commands"
	return 0
}


## p_cmd_list_commands
##
## Implements the list_commands command, listing all available commands
## along with summary information. Returns 0.
##
function p_cmd_list_commands() {
	local cmd=
	
	if [[ "$1" != "--short" ]]; then
		echo "Available Commands"
		echo "------------------"
	fi
	
	for module in $(ls "${P_LIBDIR}/commands"/*.command); do
		cmd=$(basename "${module}" | sed s/\.command$//)
		if [[ "$1" != "--short" ]]; then
			echo
			echo "${cmd}"
			echo "  $(command_summary ${cmd})"
		else
			echo "${cmd}"
		fi
	done
	
	if [[ "$1" != "--short" ]]; then
		echo
		echo "For command help, run: pulley <command> --help"
	fi
	
	return 0
}
